Vcenter VM InstantCloneSpec

Vcenter VM InstantCloneSpec
Vcenter VM InstantCloneSpec

Document-based InstantClone spec.

This schema was added in vSphere API 6.7.1.

JSON Example
{
    "source": "string",
    "name": "string",
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "datastore": "string"
    },
    "nics_to_update": {
        "nics_to_update": {
            "upt_compatibility_enabled": false,
            "upt_v2_compatibility_enabled": false,
            "mac_type": "string",
            "mac_address": "string",
            "wake_on_lan_enabled": false,
            "backing": {
                "type": "string",
                "network": "string",
                "distributed_port": "string"
            },
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "disconnect_all_nics": false,
    "parallel_ports_to_update": {
        "parallel_ports_to_update": {
            "backing": {
                "type": "string",
                "file": "string",
                "host_device": "string"
            },
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "serial_ports_to_update": {
        "serial_ports_to_update": {
            "yield_on_poll": false,
            "backing": {
                "type": "string",
                "file": "string",
                "host_device": "string",
                "pipe": "string",
                "no_rx_loss": false,
                "network_location": "string",
                "proxy": "string"
            },
            "start_connected": false,
            "allow_guest_control": false
        }
    },
    "bios_uuid": "string"
}
string
source
Required

Virtual machine to InstantClone from.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string
name
Required

Name of the new virtual machine.

This property was added in vSphere API 6.7.1.

placement
Optional

Virtual machine placement information.

This property was added in vSphere API 6.7.1.

If this property is missing or null, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.

object
nics_to_update
Optional

Map of NICs to update.

This property was added in vSphere API 6.7.1.

If missing or null, no NICs will be updated.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

boolean
disconnect_all_nics
Optional

Indicates whether all NICs on the destination virtual machine should be disconnected from the newtwork

This property was added in vSphere API 6.7.1.

If missing or null, connection status of all NICs on the destination virtual machine will be the same as on the source virtual machine.

object
parallel_ports_to_update
Optional

Map of parallel ports to Update.

This property was added in vSphere API 6.7.1.

If missing or null, no parallel ports will be updated.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

object
serial_ports_to_update
Optional

Map of serial ports to Update.

This property was added in vSphere API 6.7.1.

If missing or null, no serial ports will be updated.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

string
bios_uuid
Optional

128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.

This property was added in vSphere API 6.7.1.

If missing or null, will be generated.